MAN

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

-

Pipes the output through cat(1) rather than less(1) or PAGER.

-ul

Use ul(1) rather than cat(1).

-M path

Specifies a directory tree in which to search. By default, man searches in d:\usr\man or the directory specified by the MANPATH environment variable, the standard location for online documentation. This option assumes path is the root of a ``normal'' directory structure.

-m path

Specifies a directory in which to search. This option does not use a directory tree. Files are searched only in the directory specified by path. This option is useful for debugging new manpages. For example, assuming you are working on a manpage named ``mycmd.1'', you can do this:

man -m . 1 mycmd

-e

Find every manpage concerning the given name regardless of section. It is expected that a ``normal'' exit from the pager will result in an exit status of 0 (in which case the search is continued in other sections). An ``abnormal'' exit should result in a nonzero exit status and the search is then terminated.

-s sect[subsect]

Specifies a section and subsection similar to the 4.2 BSD UNIX Programmer's Manual (as explained below) in which to search. If no section is specified, man searches through all of the sections. Example: ``man -s 3s fopen''.

sect

As an alternative to -s, you can specify the section (and optional subsection) as the first argument. Example: ``man 3s fopen''.

name

Searches for documentation files associated with the specified name.

-f name

Displays a one line synopsis of each online documentation file whose names match the specified word (equivalent to the whatis(1) command). For example, ``man -f chmod'' will give entries for both chmod(1) and chmod(2). Note that man invokes whatis(1) in this case, so it should be found in the path (see ENVIRONMENT).

-k keyword

Displays a one line synopsis of each online documentation file whose name or description contains the specified keyword (equivalent to the apropos(1) command). Note that man invokes apropos(1) in this case, so it should be found in the path (see ENVIRONMENT).

ENVIRONMENT

MANPATH,MANDIR

Location of main manual direcotry, where subdirectories are to be found. Man uses (in order of priority) the path specified with -M, the MANPATH specified, or the built-in default (c:\man).

MANPAGER

Name of prefered pager. Use this pager if you have compressed manpages (see manpager(1)). Man will use first MANPAGER, if found, then PAGER, if found. If neither are found, it uses c:\bin\less.ttp.

PAGER

Name of secondary pager to replace less(1). Use this if you do not have manpages generated with font changes (see nroff(1)). Either MANPAGER or PAGER should be defined. The search order is MANPAGER then PAGER.

SECTION NAMES

Sect    Section Name    Description
----    -------------   --------------------------------------
0       General         overview of features and documentation
1       Commands        user commands
2       System Calls    low-level system library calls (C)
3       Library Calls   standard user calls (C)
4       Special Files   special system files and hardware
5       File formats    things like arc(1) file formats
6       Games           games manual
7       Miscellaneous   miscellaneous information
8       Administration  system administration commands

In addition, man recognizes the following section names:

local           files specific to local system
new             files added since current software release
old             files from previous software release
gnu             GNU files
paper           misc formal papers
doc             misc documentation

The search order, if no section is specified, is:

108234576

In addition to sections, there are a number of subsections possible, though these files do not reside in a special directory. The subsection name is simply appended to the file name. Example: ``fopen.3s'' resides in $MANPATH\man3, the section is ``3'' (libraries) and the subsection is ``s'', stdio. Here is the subsection search order for subsections in each section (the square brackets mean a choice of each character contained in them, in that order):

man1\*.1[tcgesla]       util & text, com, graphics, edit, shell,
                        lang, archival
man0\*.0
man8\*.8[s]             util & system
man2\*.2[gbx]           system & gemdos, bios, xbios
man3\*.3[msvcxg]        C lib & math, stdio, sysV, compat,
                        extra, gem(aes/vdi)
man4\*.4[dkvscm]        general & disk, keyboard, video, sound,
                        chips, memory
man5\*.5
man7\*.7
man6\*.6

NOTES

        .so man3\ferror.3s

which will cause man to display the contents of ``ferror.3s'' instead. Note the relative path (relative to MANPATH, by default d:\usr\man). In this way, numerous manpages can refer to a single (larger) file. Do not compress files with source lines as man only checks for this line if it finds a file which is not compressed. Note that you can only compress files for viewing with manpager(1) and must set the MANPAGER environment variable as well.  

FILES

d:\usr\man              root of standard manual page directory tree
d:\usr\man\man*\*       manual entries
d:\usr\man\whatis       table of contents and keyword database

SEE ALSO

AUTHOR

VERSION

Index

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

ENVIRONMENT

SECTION NAMES

NOTES

FILES

SEE ALSO

AUTHOR

VERSION